Skip to content

add madr for choosing data apis#352

Open
nguyenduy wants to merge 3 commits intomainfrom
duy-madr-data-api
Open

add madr for choosing data apis#352
nguyenduy wants to merge 3 commits intomainfrom
duy-madr-data-api

Conversation

@nguyenduy
Copy link
Contributor

@nguyenduy nguyenduy commented Apr 4, 2025 •
edited by sourcery-ai bot
Loading

Summary by Sourcery

Add a decision record (MADR) for choosing between Apollo Data Loader and Mongoose APIs when querying MongoDB

New Features:

  • Introduce a decision-making framework for selecting appropriate MongoDB querying methods in different scenarios

Documentation:

  • Create a comprehensive decision record (MADR) documenting the strategy for selecting between Apollo Data Loader and Mongoose APIs based on query context and performance considerations

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 4, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces a decision record (MADR) that formalizes the approach for selecting between apollo-datasource-mongodb and Mongoose APIs when interacting with MongoDB. The MADR provides guidelines based on the function's usage (resolvers vs. backend logic), the need for field projections, datetime comparisons, and nested field population. It aims to optimize query performance, maintain code maintainability, and ensure consistency across the service.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a decision record (MADR) to document the strategy for choosing between apollo-datasource-mongodb and Mongoose APIs for data access.
  • Created a new markdown file outlining the context, decision drivers, considered options, and the final decision.
  • Documented the pros and cons of using apollo-datasource-mongodb versus Mongoose APIs.
  • Included a decision tree diagram to visually guide the selection process.
  • Added performance comparison charts to illustrate the impact of different data access methods.
 docusaurus/docs/decisions/0012-data-loader-vs-mongoose.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@nguyenduy nguyenduy requested review from etang93 and nnoce14 April 4, 2025 18:22
sourcery-ai[bot]
sourcery-ai bot reviewed Apr 4, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @nguyenduy - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The decision criteria are well-defined and actionable, making it easy to understand when to use each approach.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@etang93 etang93 Awaiting requested review from etang93

@nnoce14 nnoce14 Awaiting requested review from nnoce14

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@nguyenduy